Tangible Software Solutions
C# to C++ Converter Help
Contents
- Project & Folder Conversion
- File & Snippet Conversion
- Command Line Conversion
- Code Formatting Options
- Modern C++ Options
- Header File Options
- Property Conversion Options
- Additional Stack Allocation Types
- Project Conversion Groups
- Preprocessor #region Options
- Additions & Omissions
- Default Shared Assemblies for Conversions
- Assumed Imported Namespaces for Snippet Conversions
- Conversion Message Options
- Custom String Replacements
- Type & Member Replacements
- Diagnostic Options
- File Encoding Options
- Naming Conventions
- Omit Types from Conversion
- Miscellaneous Options
- Assembly Resolution
Project & Folder Conversion
The Project & Folder Converter tab allows you to convert all C# code
within a project or folder. Once the files are converted, you can then view C# to C++ Converter
comments, compare converted code files to original code files, and view the converted code folder.
The Conversion History listview displays previously converted sources and allows you to view
remaining C# to C++ Converter comments and view the converted code folder.
Note that due to the lack of similarity between C# and C++ project types and project files,
C# to C++ Converter does not generate C++ project files. You need to assemble the resulting
header and .cpp files generated by C# to C++ Converter.
The default output of the conversion is the traditional .h and .cpp file separation, but you can
select the option of outputting to just header files (with combined declaration and
implementation details).
File & Snippet Conversion
The File & Snippet Converter tab allows you to convert
C# code snippets or files. From the left side textbox, you can type
or paste code snippets, insert files, or view C# to C++ Converter sample snippets.
Once a file or snippet is converted, you can select and copy the results, save the
results to a file, or search the results.
Command Line Conversion
C# to C++ Converter can be launched from the command line with one,
two, or three parameters plus an optional last parameter indicating the location of a conversion
options file. If only one parameter is specified, it is interpreted as the name of
one of your custom project conversion groups. If two parameters are specified, the first
parameter is either a C# project file, folder, or file that you wish to convert, and the
second parameter is the folder or header file that the converted C++ files will be written to.
If the optional last parameter indicating the location of a conversion options file is included, then
that file is imported before the conversion starts. A conversion options file
has the extension '.opt' and is produced by exporting existing options to an xml file from the converter.
e.g. (project group conversion),
"C# to C++ Converter" "MyProjectGroup"
e.g. (single project conversion),
"C# to C++ Converter" "C:\C# Projects\Sample Project.csproj" "C:\C++ Projects\Sample Target Folder"
e.g. (folder conversion),
"C# to C++ Converter" "C:\C# Projects\Sample Source Folder" "C:\C++ Projects\Sample Target Folder"
e.g. (file conversion),
"C# to C++ Converter" "C:\C# Source Files\testfile.cs" "C:\C++ Converted Files\testfile.h"
e.g. (folder conversion with a conversion options file specified),
"C# to C++ Converter" "C:\C# Projects\Sample Source Folder" "C:\C++ Projects\Sample Target Folder" "C:\Options\C# to C++ Converter.opt"
Once the command line conversion is complete, C# to C++ Converter will shut down.
Note that C# to C++ Converter must be in double quotes since the executable name contains spaces.
- Braces: You can choose whether to place opening
braces on the next line after the construct header (default) or at the end of the same line.
You can choose whether to have braces vertically aligned with the construct (default) or
indented. Loops and if or else blocks with a single statement are converted by default
with enclosing braces. If you prefer to exclude braces for these cases then check
the preference to remove braces for single statement loops and if/else blocks.
- Indentation: You can choose whether the converted code uses
tabs or spaces for the leading white space. If you choose tabs for leading white space, then
leading spaces in the original code of the length that you specify are replaced by tabs. If you
choose spaces for leading white space, then tabs in the original code are replaced by spaces
of the length that you specify.
- Spacing: You can choose the degree to which
C# to C++ Converter inserts spaces in the converted code. By default, binary operators
are padded with spaces and control structures have a space inserted after the keyword,
but you can switch off this behavior or insert spaces in other situations.
- Line Endings: By default, the converter separates lines
of code in the output by the Windows line ending \r\n. If you want the non-Windows line
ending \n, then you can choose this option.
- Pointers: You can select
to place the pointer symbol either "immediately before name"
or "immediately after type".
- Control Statements: If you
select this option, the converter will break apart control structure statements
(if and while statements) by the main conditions. See the output in the
textbox to see the effect of this option.
- Method Declarations: If you select this
option, the converter will break apart method declarations by the method parameters. See the
output in the textbox to see the effect of this option.
- Method Calls: If you select this
option, the converter will break apart method calls by the method call arguments. See the
output in the textbox to see the effect of this option.
- String Literal Concatenation: If you select this
option, the converter will break apart multiple string literal concatenations to separate
lines. See the output in the textbox to see the effect of this option.
Modern C++ Options
- Convert to fixed-width integer types: Select this
option if you want to convert to fixed-width integer types defined in the cstdint header.
- Convert string.Format to C++20 std::format: Select this
option if you are targeting C++20 and wish to use std::format.
- Allow nested namespaces in single namespace statements:
C++17 allows nested namespaces in a single namespace statement. Select this
option if you are targeting C++17.
- Allow simple string literal concatenation:
C++14 allows simple string literal concatenation without the need for any casting.
- Convert System.Object to std::any: Select this option
if you would like the std::any type (C++17) to be used as a replacement
for System.Object.
- Convert to 'smart' pointers via C++11 std::shared_ptr:
You have the option of converting to std::shared_ptr smart pointers.
This option doesn't apply to arrays - if you want a similar approach to
arrays, use the 'convert arrays to std::vector' option.
- Convert 'lock' blocks to std::scoped_lock: By default,
lock blocks are converted to std::scoped_lock (C++17).
- Convert System.Nullable to std::optional: By default,
the converter translates nullable types to std::optional (C++17).
- Convert base class and 'new' generic constraints using C++20 concepts:
C++20 provides a syntax and library for template constraints. Select this option if you are targeting C++20.
- Convert object initializers to C++20 designated initializers:
C++20 provides a syntax for named field initialization similar to C# object initializers.
Select this option if you are targeting C++20.
- Header file guards: C# to C++ Converter includes
#pragma once statements in header files by default, but if you need to use the
traditional header guard approach (using #ifndef / #define), then select this option.
The capitalized header name is used plus any prefix or suffix that you enter.
- Keep template type implementations within header files:
By default, C# to C++ Converter keeps template type implementations within header files
regardless of the output option you select. This is the most common approach to template types,
however you can choose to have the implementations in the .cpp file if you wish.
- Keep template method implementations within header files:
By default, C# to C++ Converter keeps template method implementations within header files
regardless of the output option you select. This is the most common approach to template methods,
however you can choose to have the implementations in the .cpp file if you wish.
- Add #include statements for unknown types: By default,
C# to C++ Converter adds #include statements corresponding to the types referenced in the
code which are also defined in the code being converted. However, if you select this option,
the converter will add #include statements for types not defined in the code being converted.
- Add #include "stdafx.h": Select this option if you want
the converted code to include stdafx.h for Microsoft-specific implementations.
Property Conversion Options
- Convert automatic properties to fields: Automatic
properties are converted by default to get/set methods, but you can choose
to have these converted simply to fields.
- Make accessor methods const: By default,
the converter makes all accessor methods const, unless you unselect this option.
- Adjust syntax of assembly property calls to get/set naming: Calls
to properties in referenced assemblies are not adjusted by default, but you can choose to have
these adjusted to get/set naming if you select this option.
- Mark properties with __declspec: You have the option here
of using __declspec 'property' to continue to call the property using the C#-style property
syntax in C++ code (the option is turned off by default since it's strictly a Microsoft
construct).
- Naming convention of the final accessor and mutator methods: C#
properties convert to C++ accessor and mutator methods (get/set methods). You have the
option of using different naming conventions for these methods.
Additional Stack Allocation Types
C# to C++ Converter handles conversion of type references and
method parameters based on whether the type is a C# struct, enum, class, or interface.
For method parameters, the usage of the ref and out modifiers also influences the conversion.
However, if you want to force certain types to be allocated on the stack, you can
specify that here. This forces the converter to treat
the specified type as if it were originally a value type. 'Variables are reference variables,
if possible' forces the converter to declare variables of the type as references if they're
assigned to another instance. 'Parameters are reference parameters' forces the converter
to always convert to reference parameters for specified type.
'Non-ref parameters are const' forces the converter to always add the const
modifier to parameters of the specified type unless the parameter was
originally a C# ref parameter.
Project Conversion Groups
If you need to regularly convert many projects at the same time,
use the Conversion Groups feature. This is most commonly used to convert sets of sample
projects to C++ header files.
To configure Conversion Groups, go to Options->Project Conversion Groups on the main menu
or toolbar.
To convert a Conversion Group, go to Convert->Convert Group on the main menu.
Preprocessor #region Options
C# #region and #endregion
directives are commented by default, but you can choose to remove
them, convert them to #ifndef blocks, or convert them to Visual C++ #pragma region directives.
Additions & Omissions
- Add to the top of all converted header files: If you add
text for this option, that text will be added to the top of every converted header file.
This option does not apply to code snippet conversions.
- Add to the top of all converted .cpp files: If you add
text for this option, that text will be added to the top of every converted .cpp file.
This option does not apply to code snippet conversions.
- Omit code regions for these preprocessor tokens:
C# to C++ Converter will remove regions of code from the conversion output which are
in preprocessor blocks positively conditional on any of these tokens (e.g., #if OMIT).
- Copy code unconverted for these preprocessor tokens:
C# to C++ Converter will leave regions of code unconverted which are in preprocessor blocks
positively conditional on any of these tokens (e.g., #if COPY). Any #elif or #else blocks
following the #if section are removed from the conversion output.
Default Shared Assemblies for Conversions
For snippet and folder conversions, you can specify the
assemblies that the converter should resolve when interpreting the original code.
For .NET Core SDK projects, the project file contains no information about the shared
assemblies used by the project. The converter will not automatically attempt to resolve
every assembly in the .NET Core shared assembly location since it takes time to resolve the type
information in each assembly. Instead, we resolve only the shared assembly defining the core types
(System.Private.CoreLib) and allow you to select other assemblies for each project SDK that
you typically use.
For .NET Framework SDK projects, the project file contains no information about the GAC
assemblies used by the project. The converter will not automatically attempt to resolve
every assembly in the .NET Framework GAC assembly location since it takes time to resolve the type
information in each assembly. Instead, we resolve only the GAC assemblies 'mscorlib' and
'System' and allow you to select other assemblies for each project SDK that
you typically use.
Assumed Imported Namespaces for Snippet Conversions
You can specify namespaces that you would like the snippet converter
to assume are available when interpreting the original code. The snippet converter will then
convert as if the snippet contained the corresponding 'using' directives.
Conversion Message Options
On this options dialog, you can customize the comment prefixes
that the converter uses for messages and also toggle the messages that C# to C++ Converter
displays on or off.
You can easily set all or none to display via the 'Select All' and 'Select None' buttons.
Custom String Replacements
C# to C++ Converter allows you to specify your own custom
replacements in the converted C++ code. This can be useful for customizing code according
to style preferences that may be different in C++ than in C#. It's also useful for cases
where a C# method without a good C++ equivalent will be replaced by your own custom method
to be called from the converted code.
For each replacement string you can specify the regex option, when to perform the replacement
(pre or post conversion), whether or not to match case, whether to match whole words only,
and whether comments or string literals should be modified. The whole words and string literals
options do not apply if the regex option is selected.
To span mulitple lines, either paste directly into the 'Find' and 'Replacement'
textboxes, or use the escaped characters: \r\n\t.
The "Active" checkbox can be unchecked if you wish to temporarily bypass the replacement.
Replacements are made in the order that they appear on the options dialog. For example,
the second replacement is made to each line of code after the first replacement has already
been made. To change the order of replacements, use the 'Up' and 'Down' buttons.
For an example of the regex option, you could do a custom replacement of "Foo(x)" with "Bar(x)",
where "x" is any argument, by specifying the "Find" field as "Foo(([\sa-zA-Z_$]*))" and the
"Replace" field as "Bar$1". Note that there are differences in various regex engines - the
regex engine used by the converter is .NET System.Text.RegularExpressions.Regex.
Type & Member Replacements
C# to C++ Converter allows you to specify your own custom type and
member replacements in the converted code. This can be useful for cases where you wish to
specify replacements for .NET member calls of a specific type that are not handled
by C# to C++ Converter.
For each external type, you can specify an optional type replacement and multiple member
replacements. For types, you can specify template/generic types, which may include '?' as
a wildcard type. A wildcard in the replacement type must have a matching wildcard in the
same position in the original type.
e.g., the following will replace all references to type 'Foo' having one 'int' type parameter
with 'Bar', having no type parameters:
original type: Foo<int>
replacement type: Bar
e.g., the following will replace all references to type 'Foo' having one type parameter of any
type with 'Bar', having the same type parameter:
original type: Foo<?>
replacement type: Bar<?>
For each member replacement, you specify the original member name, whether the member is static
or not, and whether the member is a method or a field. You also specify the number of arguments
you expect.
For the replacement member, you specify whether the replacement is static or not, and whether
the replacement is a method or a field. You also specify the new list of arguments and can
add literal arguments. For replacement of static methods with instance members, you also
specify the argument position which corresponds to the object instance for the new instance
member. For replacement of instance members with static members, you specify the new class
name used to call the static member (for static methods, you also specify the position in
the argument list to insert the previous instance qualifier, using the string "instance"
(quotes not included) at the appropriate position in the "new argument list" field).
For example, if you want to replace all instance calls to the 'Foo' type method 'Bar'
where you want the instance qualifier to be the new first argument, you would specify
"instance, a1" (quotes not included) for the "new argument list" field, assuming that there
was one argument in the original method calls.
Diagnostic Options
These options are intended to provide information to
Tangible Software Solutions if a conversion is taking longer than expected.
'Record processing by file' instructs the converter to make a record of the files
processed and the time taken for each process. 'Record the last 100 lines of code
parsed before cancelling conversion' instructs the converter to make a record of the
most recent lines parsed before you cancelled the conversion.
File Encoding Options
The converter detects input file encoding from the byte order
mark (BOM), but if the BOM is missing the converter assumes by default that the file encoding
is UTF-8. You can use this option to specify a different default encoding to use in the absence
of a BOM. Output is written in the same encoding as the encoding detected for the original file,
or your default encoding option if the original coding was not detected via the BOM.
For UTF-8, you can choose whether or not to include the BOM for the output - this is normally
used in Windows environments.
Naming Conventions
By default, the converter does not change naming conventions,
but you can select these options to cause the converter to modify names to conform
to these common C++ conventions.
Omit Types from Conversion
Any type entered here will be omitted from most
conversion logic. You would normally enter library type names here to prevent the
default conversion of objects of those types.
Miscellaneous Options
- Renaming tag for C++ keyword conflicts: C# to C++ Converter
must occasionally rename identifiers that are keywords in C++. You can choose your own
renaming tag and whether to place it at the beginning or end of the original name when
this is necessary.
- String & character conversion: The C# types string and
char convert to the C++ types std::wstring and wchar_t by default,
but you also have the option of converting to std::string and char,
std::u16string and char16_t, or std::u32string and char32_t.
- Raw pointer memory management:
- Add destructor 'delete' statements for class instance fields:
By default, the converter adds delete statements to the class destructor
(either the converted 'Dispose' method or a new method) for all class instance
fields using pointers (unless you have chosen to convert to 'smart' pointers).
If you want to handle this differently, then unselect this option.
- Add 'delete' statements for local variables:
By default, the converter adds delete statements for local pointer variables
that satisfy certain conditions (unless you have chosen to convert to 'smart' pointers).
The conditions are that the variable must not be assigned to a field, parameter, or a
pointer in an outer scope and the variable must not be passed to a method or
constructor - these cases must be handled manually.
If you want to handle all local pointer deallocation manually, then unselect this option.
- Field initializations in constructors: By default, the
converter moves readonly instance field initializations within constructors the constructor
init list. You can also choose to move all instance field initializations within constructors to the
init list or to leave all initializations within the constructor body.
- Copy non-code files in project or folder conversions: By default,
the converter does not copy non-code files in project or folder conversions. If you select this
option, all non-code files are copied to the target folder.
- Bypass assembly resolution dialogs: By default,
C# to C++ Converter prompts you for the location of assembly dll's that it cannot find - this
aids in identifying the best conversion for some references to these assemblies.
Also, C# to C++ Converter will display message boxes if it cannot resolve the types
or members within an assembly. Select this option if you do not want to see these dialogs.
- Preserve names for pure virtual parameters: By default,
C# to C++ Converter includes the parameter names for pure virtual method parameters.
Uncheck this if you don't want the original name included (this is optional in C++).
- Convert arrays to std::vector: By default,
C# to C++ Converter converts arrays to std::vector, but if you
unselect this option they are converted to C++ arrays.
- Use spaces in nested template closing angle brackets:
Check this preference if you are targeting C++ compilers which require
spaces in nested template closing angle brackets (e.g., A<B<C> > instead of A<B<C>>).
- Add helper classes for unconverted exceptions: By default,
the converter adds helper classes which inherit from std::exception for each
unconverted exception.
- Add 'using namespace std' to .cpp files: By default,
the converter uses the full std qualifier for std members and types.
If you select this option, the converter will remove the std qualifier
and add a using namespace std to the top of the file for .cpp files.
- Convert fundamental type value parameters to const references:
The converter converts fundamental type value parameters to
by value parameters by default. This option doesn't affect ref fundamental
type parameters which are always converted to non-const references.
- Convert string value parameters to const references:
The converter converts string value parameters to const references by
default. This option doesn't affect ref string parameters which are always converted
to non-const references.
- Convert events using a helper class: By default,
the converter converts events using a helper class. If you don't want this behavior,
uncheck this option.
- Convert System.IDisposable.Dispose methods to destructors:
Check this option if you want Dispose methods for classes implementing the
System.IDisposable interface to convert to C++ destructors.
- Generate a C++ 'main' function to call the original 'Main' method, if found:
By default, if the converter finds a C# Main method, then a C++ main function
is generated which calls the converted original Main class method.
- Convert AssemblyInfo attributes to fields: Checking
this option causes the converter to create a class called AssemblyInfo to contain fields
corresponding to the assembly attributes contained in the AssemblyInfo file.
Assembly Resolution
Assemblies referenced by projects are examined to
determine the nature of the types and members within the assembly to improve the conversion
quality.
During the project conversion process you may be prompted
by the converter to find specific assemblies referenced by your project if they
cannot otherwise be found by the converter.
If the converter does not resolve all assemblies, you can still
continue the project conversion, but the conversion may not be optimal for code which
references the unresolved assemblies. This just means that a few more manual adjustments
may be required.
If the assembly does not require an install, you can forward it
to us in a zip file to determine why it is not resolving.
Copyright © Tangible Software Solutions, Inc.